Directory Number Structure (IM: Telephony)

Chapter 3 - Directory Numbers / Directory Number Reference

Directory Number Structure
The Telephone Manager creates a directory number structure for each directory number (that is, telephone number) associated with a particular telephone terminal. A directory number structure describes the characteristics and state of that directory number. The Telephone Manager uses this information when placing calls, receiving calls, or otherwise using the directory number.
Telephone tools provide the values for most of the fields of a directory number structure. A directory number structure is like a snapshot--it describes the characteristics and state of a directory number at the time the structure is created or at the most recent update.

IMPORTANT
You can change values only in the refCon and userData fields. To be compatible with future releases of the Telephone Manager, do not directly manipulate any other fields of a directory number structure. Telephone tools and the Telephone Manager provide and maintain the values for all other fields.
The directory number structure is defined by the TELDNRecord data type.
struct TELDNRecord {
   short                   dnRef;
   StringPtr               dn;
   StringPtr               dnPartyName;
   StringPtr               dnSubaddress;
   TELHandle               hTEL;
   short                   maxAllocCA;
   short                   curAllocCA;
   short                   dnType;
   TELDNFeatureFlags       featureFlags;
   short                   numPageIDs;
   short                   numIntercomIDs;
   short                   numPickupIDs;
   TELDNForwardFlags       forwardFlags;
   StringPtr               iForwardDN;
   StringPtr               iForwardSubaddress;
   StringPtr               iForwardPartyName;
   StringPtr               bForwardDN;
   StringPtr               bForwardSubaddress;
   StringPtr               bForwardPartyName;
   StringPtr               naForwardDN;
   StringPtr               naForwardSubaddress;
   StringPtr               naForwardPartyName;
   short                   naForwardRings;
   long                    telDNPrivate;
   long                    refCon;
   long                    userData;
   long                    reserved;
};
typedef struct TELDNRecord TELDNRecord;
typedef TELDNRecord *TELDNPtr, **TELDNHandle;
Field Description

dnRef
A directory number reference number. A telephone tool dynamically generates this value to identify a particular directory number.
dn
A pointer to a Pascal-style string that contains the name (that is, the telephone number) of the directory number. Telephone tools recognize only certain kinds of characters in this string: (1) the digits '0' through '9'; (2) the number sign '#'; (3) the asterisk '*'; (4) the comma ',' (which is treated as a one-second pause); (5) the exclamation sign '!' (which is treated as a hook flash). All other characters are treated like spaces and are ignored by telephone tools. If your application accepts directory number names that include alphabetic characters, it should translate them to the appropriate numerical characters.
dnPartyName
A pointer to a Pascal-style string that contains the name of the person to whom the directory number is assigned.
dnSubaddress
A pointer to a Pascal-style string that contains the network subaddress, if any, associated with the directory number.
hTEL
A handle to the telephone record (and hence the terminal) with which this directory number is associated.
maxAllocCA
The maximum number of call appearances that the network has allocated to this directory number for placing independent outgoing calls. If maxAllocCA is set to -1, there is no maximum.
curAllocCA
The number of calls currently allocated for this directory number.
dnType
The type of this directory number. See "Directory Number Types" on page 3-6 for a description of the available directory number types.
featureFlags
A bit field that indicates certain features of this directory number and the state of each feature (subscribed, available, or active). The constants that define the bits are described in "Directory Number Feature Flags," beginning on page 3-7.
numPageIDs
The number of page IDs, or "page keys," configured for this directory number.
numIntercomIDs
The number of intercom IDs, or "intercom keys," configured for this directory number.
numPickupIDs
The number of pickup IDs configured for this directory number.
forwardFlags
A bit field that indicates certain features of the call forwarding capabilities of this directory number and the state of each feature (subscribed, available, or active). The constants that define the bits are described in "Call Forwarding Feature Flags," beginning on page 3-10.
iForwardDN
Either nil or a pointer to a Pascal-style string containing the telephone number to which calls are forwarded when the Immediate Call Forwarding feature is active.
iForwardSubaddress
Either nil or a pointer to a Pascal-style string containing the network subaddress of the telephone number to which calls are forwarded when the Immediate Call Forwarding feature is active.
iForwardPartyName
Either nil or a pointer to a Pascal-style string containing the name of the person to whom calls are forwarded when the Immediate Call Forwarding feature is active.
bForwardDN
Either nil or a pointer to a Pascal-style string containing the telephone number to which calls are forwarded when the Forward On Busy feature is active.
bForwardSubaddress
Either nil or a pointer to a Pascal-style string containing the network subaddress of the telephone number to which calls are forwarded when the Forward On Busy feature is active.
bForwardPartyName
Either nil or a pointer to a Pascal-style string containing the name of the person to whom calls are forwarded when the Forward On Busy feature is active.
naForwardDN
Either nil or a pointer to a Pascal-style string containing the telephone number to which calls are forwarded when the Forward On No Answer feature is active.
naForwardSubaddress
Either nil or a pointer to a Pascal-style string containing the network subaddress of the telephone number to which calls are forwarded when the Forward On No Answer feature is active.
naForwardPartyName
Either nil or a pointer to a Pascal-style string containing the name of the person to whom calls are forwarded when the Forward On No Answer feature is active.
naForwardRings
The number of times the telephone or terminal rings before Forward On No Answer is activated.
telDNPrivate
Reserved for telephone tools.
refCon
Reserved for your use.
userData
Reserved for your use.
reserved
Reserved.